<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.8.0" />

	<title>Class Particle\Apps\Settings | Particle</title>

	<script type="text/javascript" src="resources/combined.js?3415740931"></script>
	<script type="text/javascript" src="elementlist.js?2659508522"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Namespaces</h3>
			<ul>
				<li class="active"><a href="namespace-Particle.html">Particle<span></span></a>
						<ul>
				<li><a href="namespace-Particle.Addons.html">Addons</a>
						</li>
				<li class="active"><a href="namespace-Particle.Apps.html">Apps</a>
						</li>
				<li><a href="namespace-Particle.Core.html">Core</a>
						</li>
							</ul></li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-Particle.Apps.essential.html">essential</a></li>
				<li><a href="class-Particle.Apps.indexController.html">indexController</a></li>
				<li><a href="class-Particle.Apps.indexModel.html">indexModel</a></li>
				<li class="active"><a href="class-Particle.Apps.Settings.html">Settings</a></li>
			</ul>





		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="namespace-Particle.Apps.html" title="Summary of Particle\Apps"><span>Namespace</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
			<li>
				<a href="deprecated.html" title="List of deprecated elements"><span>Deprecated</span></a>
			</li>
			<li>
				<a href="todo.html" title="Todo list"><span>Todo</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class Settings</h1>


	<div class="description">
	
<p>Load settings from file settings.xml The configuration file defines:</p>

<ul>
	<li>The files (PHP, JS, Smarty) which must include the host.</li>

	<li>The files (PHP, JS, Smarty) to be included in any host.</li>
</ul>

	</div>









	<div class="info">
		<b>Final</b><br />
		
		<b>Namespace:</b> <a href="namespace-Particle.html">Particle</a>\<a href="namespace-Particle.Apps.html">Apps</a><br />
		<b>Package:</b> Particle<br />

				<b>Category:</b>
				Apps<br />
				<b>Author:</b>
				dertin<br />
				<b>Todo:</b>
				Falta agregar carga de archivos CSS<br />
		<b>Located at</b> <a href="source-class-Particle.Apps.Settings.html#4-297" title="Go to source code">Apps/constants/settings.inc.php</a><br />
	</div>



	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="getInstance" id="_getInstance">

		<td class="attributes"><code>
			 public static
			object|boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getInstance">#</a>
		<code><a href="source-class-Particle.Apps.Settings.html#31-48" title="Go to source code">getInstance</a>( )</code>

		<div class="description short">
			
<p>Singleton</p>

		</div>

		<div class="description detailed hidden">
			
<p>Singleton</p>




				<h4>Returns</h4>
				<div class="list">
					<code>object|boolean</code><br>If previously not start the instance in conjunction with the method
(initSettings), the result is false.<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="initSettings" id="_initSettings">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_initSettings">#</a>
		<code><a href="source-class-Particle.Apps.Settings.html#49-59" title="Go to source code">initSettings</a>( )</code>

		<div class="description short">
			
<p>It is stored in the attributes of the class:</p>

<ul>
	<li>The configuration from the XML file.</li>
</ul>

<p>This method should be invoked with the instance of the method
(getInstance)</p>

		</div>

		<div class="description detailed hidden">
			
<p>It is stored in the attributes of the class:</p>

<ul>
	<li>The configuration from the XML file.</li>
</ul>

<p>This method should be invoked with the instance of the method
(getInstance)</p>






				<h4>Example</h4>
				<div class="list">
						Apps\Settings::getInstance()-&gt;initSettings();<br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="xmlSettings" id="_xmlSettings">

		<td class="attributes"><code>
			final private 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_xmlSettings">#</a>
		<code><a href="source-class-Particle.Apps.Settings.html#61-98" title="Go to source code">xmlSettings</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			







		</div>
		</div></td>
	</tr>
	<tr data-order="loadSettingX" id="_loadSettingX">

		<td class="attributes"><code>
			final private 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_loadSettingX">#</a>
		<code><a href="source-class-Particle.Apps.Settings.html#100-177" title="Go to source code">loadSettingX</a>( <span>mixed <var>$settingFiles</var></span>, <span>mixed <var>$ext</var></span>, <span>mixed <var>$settingDir</var> = <span class="php-quote">''</span></span>, <span>mixed <var>$aHosts</var> = <span class="php-quote">''</span></span> )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			







		</div>
		</div></td>
	</tr>
	<tr data-order="loadSettings" id="_loadSettings">

		<td class="attributes"><code>
			final private 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_loadSettings">#</a>
		<code><a href="source-class-Particle.Apps.Settings.html#180-282" title="Go to source code">loadSettings</a>( <span>mixed <var>$xmlSettings</var> = <span class="php-keyword1">FALSE</span></span> )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			







		</div>
		</div></td>
	</tr>
	<tr data-order="getSettingsFilephp" id="_getSettingsFilephp">

		<td class="attributes"><code>
			final public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getSettingsFilephp">#</a>
		<code><a href="source-class-Particle.Apps.Settings.html#284-286" title="Go to source code">getSettingsFilephp</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			







		</div>
		</div></td>
	</tr>
	<tr data-order="getSettingsFilejs" id="_getSettingsFilejs">

		<td class="attributes"><code>
			final public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getSettingsFilejs">#</a>
		<code><a href="source-class-Particle.Apps.Settings.html#287-289" title="Go to source code">getSettingsFilejs</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			







		</div>
		</div></td>
	</tr>
	<tr data-order="getSettingsFilesmarty" id="_getSettingsFilesmarty">

		<td class="attributes"><code>
			final public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getSettingsFilesmarty">#</a>
		<code><a href="source-class-Particle.Apps.Settings.html#290-292" title="Go to source code">getSettingsFilesmarty</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			







		</div>
		</div></td>
	</tr>
	<tr data-order="getSettingsConfDirSmarty" id="_getSettingsConfDirSmarty">

		<td class="attributes"><code>
			final public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getSettingsConfDirSmarty">#</a>
		<code><a href="source-class-Particle.Apps.Settings.html#293-295" title="Go to source code">getSettingsConfDirSmarty</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			







		</div>
		</div></td>
	</tr>
	</table>












	<table class="summary" id="properties">
	<caption>Properties summary</caption>
	<tr data-order="_flagLoadSettings" id="$_flagLoadSettings">
		<td class="attributes"><code>
			private  
			boolean
		</code></td>

		<td class="name">
				<a href="source-class-Particle.Apps.Settings.html#18" title="Go to source code"><var>$_flagLoadSettings</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">FALSE</span></code></td>
		<td class="description"><div>
			<a href="#$_flagLoadSettings" class="anchor">#</a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</div></td>
	</tr>
	<tr data-order="_xmlSettingsSite" id="$_xmlSettingsSite">
		<td class="attributes"><code>
			private  
			mixed
		</code></td>

		<td class="name">
				<a href="source-class-Particle.Apps.Settings.html#19" title="Go to source code"><var>$_xmlSettingsSite</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">NULL</span></code></td>
		<td class="description"><div>
			<a href="#$_xmlSettingsSite" class="anchor">#</a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</div></td>
	</tr>
	<tr data-order="_xmlSettingsGlobal" id="$_xmlSettingsGlobal">
		<td class="attributes"><code>
			private  
			mixed
		</code></td>

		<td class="name">
				<a href="source-class-Particle.Apps.Settings.html#20" title="Go to source code"><var>$_xmlSettingsGlobal</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">NULL</span></code></td>
		<td class="description"><div>
			<a href="#$_xmlSettingsGlobal" class="anchor">#</a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</div></td>
	</tr>
	<tr data-order="_aFilesPHP" id="$_aFilesPHP">
		<td class="attributes"><code>
			private  
			mixed
		</code></td>

		<td class="name">
				<a href="source-class-Particle.Apps.Settings.html#21" title="Go to source code"><var>$_aFilesPHP</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">NULL</span></code></td>
		<td class="description"><div>
			<a href="#$_aFilesPHP" class="anchor">#</a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</div></td>
	</tr>
	<tr data-order="_aFilesJS" id="$_aFilesJS">
		<td class="attributes"><code>
			private  
			mixed
		</code></td>

		<td class="name">
				<a href="source-class-Particle.Apps.Settings.html#22" title="Go to source code"><var>$_aFilesJS</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">NULL</span></code></td>
		<td class="description"><div>
			<a href="#$_aFilesJS" class="anchor">#</a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</div></td>
	</tr>
	<tr data-order="_aFileSmarty" id="$_aFileSmarty">
		<td class="attributes"><code>
			private  
			mixed
		</code></td>

		<td class="name">
				<a href="source-class-Particle.Apps.Settings.html#23" title="Go to source code"><var>$_aFileSmarty</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">NULL</span></code></td>
		<td class="description"><div>
			<a href="#$_aFileSmarty" class="anchor">#</a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</div></td>
	</tr>
	<tr data-order="_sConfDirSmarty" id="$_sConfDirSmarty">
		<td class="attributes"><code>
			private  
			mixed
		</code></td>

		<td class="name">
				<a href="source-class-Particle.Apps.Settings.html#24" title="Go to source code"><var>$_sConfDirSmarty</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">NULL</span></code></td>
		<td class="description"><div>
			<a href="#$_sConfDirSmarty" class="anchor">#</a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</div></td>
	</tr>
	<tr data-order="instance" id="$instance">
		<td class="attributes"><code>
			private static 
			mixed
		</code></td>

		<td class="name">
				<a href="source-class-Particle.Apps.Settings.html#26-29" title="Go to source code"><var>$instance</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">NULL</span></code></td>
		<td class="description"><div>
			<a href="#$instance" class="anchor">#</a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</div></td>
	</tr>
	</table>






</div>

	<div id="footer">
		Particle API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
</div>
</div>
</body>
</html>
